home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / plain / contrib / chbar / readme < prev    next >
Encoding:
Text File  |  1991-04-09  |  4.6 KB  |  117 lines
  1. % README for changebar macros            09 Apr 91
  2. %------------------------------------------------------------
  3.  
  4.  
  5. GENERAL NOTES
  6.  
  7. These are my macros for producing changebars with Plain TeX.  Please
  8. note that (1) these macros will not produce an optimal page breaking
  9. (i.e. vertical glue will disappear in many places) and (2) that there
  10. is still a problem with these macros: it is described in the last
  11. section of the chapter `Handling the Page Contents.' By the way, this
  12. problem is within the current LaTeX, too.
  13.     The macros were written for TeX 2. In the meantime TeX 3 became
  14. available; new features (i.e., \holdinginsert) would now allow a
  15. better implementation.
  16.  
  17. The macros are written for the usage with Plain TeX. I will not do
  18. the LaTeX adaption because I neither use LaTeX in my own documents
  19. nor do I need changebars... For me it was just a nice play to show
  20. what can be done with the \output routine of TeX. Therefore I will
  21. not put further work in these macros. But I will happily redistribute
  22. enhancements and will make them available on the usual TeX servers.
  23.  
  24. So: If you enhance the macros, or if you adapt them to LaTeX, or if
  25. you incorporate the new features of TeX 3, send them to me so that
  26. others can share your work.
  27.  
  28.  
  29. NOTES ON THE DISTRIBUTED FILES
  30.  
  31. The macro file chbars.doc can be LaTeXed (the result is not as
  32. readable as it should be---but this is due to the inflexibility of
  33. the \@startsection macro of LaTeX).  The needed style files are
  34. included.  Furthermore two test files (test1.tex and test2.tex) for
  35. the usage of change bars in vertical and horizontal mode are
  36. included, too.
  37.  
  38. These macros are documented with my MAKEPROG processor.  Perhaps I
  39. should mention why I don't use the doc-option of Frank Mittelbach:
  40. MAKEPROG has been written by me before I have heard of the existence
  41. of doc. But even then I would have written it: doc is a special
  42. documentation tool for TeX macros which heavily depends on LaTeX and
  43. the LaTeX coding conventions.  It is not very easy to use it for the
  44. documentation of other stuff than LaTeX macros.  In contrary, MAKEPROG
  45. is a {\it general documentation facility\/} which I use for all things
  46. where WEB is not available.  (In fact, it was created to document lex
  47. and yacc programs...) Especially the changefile possibility I need
  48. very hardly.  MAKEPROG has the disadvantage that a special care of the
  49. TeX environment (e.g. the indexing of macro names) can not be
  50. implemented. I'm still working on MAKEPROG, the next version 2.0 will
  51. have a code rearrangement ability like TANGLE. 
  52.  
  53. MAKEPROG may be fetched from LISTSERV@DHDURZ1 (for the Bitnet folks)
  54. and per ftp from Washington (where it is in the UNIX distribution).  I
  55. would prefer if you get it from there so that I don't have to mail out
  56. so much stuff.  If you have no access contact me.  If you are working
  57. on an IBM(-compatible) PC you should nevertheless contact me: I have
  58. changefiles for Turbo Pascal available. 
  59.  
  60. I'm not really satisfied that I have not found the time to update the
  61. documentation of MAKEPROG to mention that progltx, the
  62. progdoc-equivalent LaTeX style option, exists.  To get a
  63. documentation you must run LaTeX over progltx.doc and print the
  64. result.  Because I print the whole stuff usually on A4 paper I have
  65. included a style option for A4 page layout, too.  The macro file
  66. a4-9.sty assumes that the driver leaves a margin of 1 in.  Please
  67. note, that this is not just ``one other'' A4 page layout -- it was
  68. designed by a typographer and I have only done the LaTeX
  69. realization---have a look at a4-9.doc!
  70.  
  71. Perhaps it is of interest for you how the verbatim typesetting in
  72. progltx is done---the scheme is robuster than the one LaTeX uses, it
  73. works with tabs (are you working on a VAX or a PC?), but it's slower,
  74. too. In the last sections of the files you can have a look at the
  75. `great' internal design of the current LaTeX, too.
  76.  
  77.  
  78.  
  79. Well, I hope that you will enjoy the macros
  80.  
  81.             Greetings
  82.             Joachim Schrod
  83.  
  84.  
  85. current address:
  86.     Technical University of Darmstadt
  87.     Department of Computer Science
  88.     Joachim Schrod
  89.     Alexanderstr. 10
  90.  
  91.     D-6100 Darmstadt
  92.     FR Germany
  93.  
  94.     Email: xitijsch@ddathd21.bitnet
  95.  
  96.  
  97. ==============================================================================
  98.  
  99. The following files are in the distribution:
  100.  
  101. COPYING        copy conditions, i.e. the GNU General Public License
  102. README        this file you are reading
  103.  
  104. chbars.doc      The documented macro source (with MAKEPROG!)
  105. progltx.sty     Style files needed to print it.
  106. a4-9.sty
  107.  
  108. chbars.tex    the macro version of chbars.doc
  109. test1.tex    Test files for chbars.tex
  110. test2.tex
  111.  
  112. a4-9.doc        a non-arbitrary A4 page layout style option
  113. a4-marg.chf     changefile for a4-9.doc, adaption to 1in driver margin
  114.  
  115.  
  116. --
  117.